        /*
         * @(#)Annotation.java	1.17 06/10/10
         *
         * Copyright  1990-2006 Sun Microsystems, Inc. All Rights Reserved.  
         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER  
         *   
         * This program is free software; you can redistribute it and/or  
         * modify it under the terms of the GNU General Public License version  
         * 2 only, as published by the Free Software Foundation.   
         *   
         * This program is distributed in the hope that it will be useful, but  
         * WITHOUT ANY WARRANTY; without even the implied warranty of  
         * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU  
         * General Public License version 2 for more details (a copy is  
         * included at /legal/license.txt).   
         *   
         * You should have received a copy of the GNU General Public License  
         * version 2 along with this work; if not, write to the Free Software  
         * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  
         * 02110-1301 USA   
         *   
         * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa  
         * Clara, CA 95054 or visit www.sun.com if you need additional  
         * information or have any questions. 
         *
         */

        package javame.text;

        /**
         * An Annotation object is used as a wrapper for a text attribute value if
         * the attribute has annotation characteristics. These characteristics are:
         * <ul>
         * <li>The text range that the attribute is applied to is critical to the
         * semantics of the range. That means, the attribute cannot be applied to subranges
         * of the text range that it applies to, and, if two adjacent text ranges have
         * the same value for this attribute, the attribute still cannot be applied to
         * the combined range as a whole with this value.
         * <li>The attribute or its value usually do no longer apply if the underlying text is
         * changed.
         * </ul>
         *
         * An example is grammatical information attached to a sentence:
         * For the previous sentence, you can say that "an example"
         * is the subject, but you cannot say the same about "an", "example", or "exam".
         * When the text is changed, the grammatical information typically becomes invalid.
         * Another example is Japanese reading information (yomi).
         *
         * <p>
         * Wrapping the attribute value into an Annotation object guarantees that
         * adjacent text runs don't get merged even if the attribute values are equal,
         * and indicates to text containers that the attribute should be discarded if
         * the underlying text is modified.
         *
         * @see AttributedCharacterIterator
         */

        public class Annotation {

            /**
             * Constructs an annotation record with the given value, which
             * may be null.
             * @param value The value of the attribute
             */
            public Annotation(Object value) {
                this .value = value;
            }

            /**
             * Returns the value of the attribute, which may be null.
             */
            public Object getValue() {
                return value;
            }

            /**
             * Returns the String representation of this Annotation.
             */
            public String toString() {
                return getClass().getName() + "[value=" + value + "]";
            }

            private Object value;

        };
